<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxPvd Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxPvd.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classPxPvd-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxPvd Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__pvd.html">Pvd</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface for PVD configura...">PxPvd</a> is the top-level class for the PVD framework, and the main customer interface for PVD configuration.It is a singleton class, instantiated and owned by the application.  
 <a href="classPxPvd.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxPvd_8h_source.html">PxPvd.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PxPvd:</div>
<div class="dyncontent">
<div class="center"><img src="classPxPvd__inherit__graph.png" border="0" usemap="#PxPvd_inherit__map" alt="Inheritance graph"/></div>
<map name="PxPvd_inherit__map" id="PxPvd_inherit__map">
<area shape="rect" id="node2" href="classphysx_1_1PxProfilerCallback.html" title="The pure virtual callback interface for general purpose instrumentation and profiling of GameWorks mo..." alt="" coords="5,5,176,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PxPvd:</div>
<div class="dyncontent">
<div class="center"><img src="classPxPvd__coll__graph.png" border="0" usemap="#PxPvd_coll__map" alt="Collaboration graph"/></div>
<map name="PxPvd_coll__map" id="PxPvd_coll__map">
<area shape="rect" id="node2" href="classphysx_1_1PxProfilerCallback.html" title="The pure virtual callback interface for general purpose instrumentation and profiling of GameWorks mo..." alt="" coords="5,5,176,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a23c137a2fe3c347382ea17a3b8bfa06d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#a23c137a2fe3c347382ea17a3b8bfa06d">connect</a> (<a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> &amp;transport, <a class="el" href="group__pvd.html#ga4e8b7695b7145523688243b39da116c9">PxPvdInstrumentationFlags</a> <a class="el" href="PxConstraintDesc_8h.html#acfdd81caa30ceb0af5fafb4064b1bc67">flags</a>)=0</td></tr>
<tr class="separator:a23c137a2fe3c347382ea17a3b8bfa06d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe4f8510743ad3ac6b98ef0b94597299"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#afe4f8510743ad3ac6b98ef0b94597299">disconnect</a> ()=0</td></tr>
<tr class="separator:afe4f8510743ad3ac6b98ef0b94597299"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6ab8818ce89858b70e6e7a868cbcf6f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#af6ab8818ce89858b70e6e7a868cbcf6f">isConnected</a> (bool useCachedStatus=true)=0</td></tr>
<tr class="separator:af6ab8818ce89858b70e6e7a868cbcf6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abacb259344c650f6cdededbb9b9f7c27"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#abacb259344c650f6cdededbb9b9f7c27">getTransport</a> ()=0</td></tr>
<tr class="separator:abacb259344c650f6cdededbb9b9f7c27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1824e29488871970252cdc2ed6bc54e5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__pvd.html#ga4e8b7695b7145523688243b39da116c9">PxPvdInstrumentationFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#a1824e29488871970252cdc2ed6bc54e5">getInstrumentationFlags</a> ()=0</td></tr>
<tr class="separator:a1824e29488871970252cdc2ed6bc54e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43e5b5e2d72edb4a322caf6cfb55dd58"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#a43e5b5e2d72edb4a322caf6cfb55dd58">release</a> ()=0</td></tr>
<tr class="memdesc:a43e5b5e2d72edb4a322caf6cfb55dd58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the pvd instance.  <a href="#a43e5b5e2d72edb4a322caf6cfb55dd58">More...</a><br /></td></tr>
<tr class="separator:a43e5b5e2d72edb4a322caf6cfb55dd58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classphysx_1_1PxProfilerCallback"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classphysx_1_1PxProfilerCallback')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classphysx_1_1PxProfilerCallback.html">physx::PxProfilerCallback</a></td></tr>
<tr class="memitem:ac56a58ecceddf722cc977b60d2dd04e9 inherit pub_methods_classphysx_1_1PxProfilerCallback"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxProfilerCallback.html#ac56a58ecceddf722cc977b60d2dd04e9">zoneStart</a> (const char *eventName, bool detached, uint64_t contextId)=0</td></tr>
<tr class="memdesc:ac56a58ecceddf722cc977b60d2dd04e9 inherit pub_methods_classphysx_1_1PxProfilerCallback"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark the beginning of a nested profile block.  <a href="classphysx_1_1PxProfilerCallback.html#ac56a58ecceddf722cc977b60d2dd04e9">More...</a><br /></td></tr>
<tr class="separator:ac56a58ecceddf722cc977b60d2dd04e9 inherit pub_methods_classphysx_1_1PxProfilerCallback"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44a5930843bb99af0264a6872cc120cb inherit pub_methods_classphysx_1_1PxProfilerCallback"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxProfilerCallback.html#a44a5930843bb99af0264a6872cc120cb">zoneEnd</a> (void *profilerData, const char *eventName, bool detached, uint64_t contextId)=0</td></tr>
<tr class="memdesc:a44a5930843bb99af0264a6872cc120cb inherit pub_methods_classphysx_1_1PxProfilerCallback"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark the end of a nested profile block.  <a href="classphysx_1_1PxProfilerCallback.html#a44a5930843bb99af0264a6872cc120cb">More...</a><br /></td></tr>
<tr class="separator:a44a5930843bb99af0264a6872cc120cb inherit pub_methods_classphysx_1_1PxProfilerCallback"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aa96f4b9b5f46ee7447ac5eb7d9ca4f42"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvd.html#aa96f4b9b5f46ee7447ac5eb7d9ca4f42">~PxPvd</a> ()</td></tr>
<tr class="separator:aa96f4b9b5f46ee7447ac5eb7d9ca4f42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classphysx_1_1PxProfilerCallback"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classphysx_1_1PxProfilerCallback')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classphysx_1_1PxProfilerCallback.html">physx::PxProfilerCallback</a></td></tr>
<tr class="memitem:a1ba891db352394fcb7c3ccfcce066643 inherit pro_methods_classphysx_1_1PxProfilerCallback"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphysx_1_1PxProfilerCallback.html#a1ba891db352394fcb7c3ccfcce066643">~PxProfilerCallback</a> ()</td></tr>
<tr class="separator:a1ba891db352394fcb7c3ccfcce066643 inherit pro_methods_classphysx_1_1PxProfilerCallback"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface for PVD configura...">PxPvd</a> is the top-level class for the PVD framework, and the main customer interface for PVD configuration.It is a singleton class, instantiated and owned by the application. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa96f4b9b5f46ee7447ac5eb7d9ca4f42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa96f4b9b5f46ee7447ac5eb7d9ca4f42">&#9670;&nbsp;</a></span>~PxPvd()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxPvd::~PxPvd </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a23c137a2fe3c347382ea17a3b8bfa06d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23c137a2fe3c347382ea17a3b8bfa06d">&#9670;&nbsp;</a></span>connect()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxPvd::connect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> &amp;&#160;</td>
          <td class="paramname"><em>transport</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__pvd.html#ga4e8b7695b7145523688243b39da116c9">PxPvdInstrumentationFlags</a>&#160;</td>
          <td class="paramname"><em>flags</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Connects the SDK to the PhysX Visual Debugger application. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">transport</td><td>transport for pvd captured data. </td></tr>
    <tr><td class="paramname">flags</td><td>Flags to set. return True if success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="afe4f8510743ad3ac6b98ef0b94597299"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe4f8510743ad3ac6b98ef0b94597299">&#9670;&nbsp;</a></span>disconnect()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvd::disconnect </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Disconnects the SDK from the PhysX Visual Debugger application. If we are still connected, this will kill the entire debugger connection. </p>

</div>
</div>
<a id="a1824e29488871970252cdc2ed6bc54e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1824e29488871970252cdc2ed6bc54e5">&#9670;&nbsp;</a></span>getInstrumentationFlags()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__pvd.html#ga4e8b7695b7145523688243b39da116c9">PxPvdInstrumentationFlags</a> PxPvd::getInstrumentationFlags </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Retrieves the PVD flags. See PxPvdInstrumentationFlags. </p>

</div>
</div>
<a id="abacb259344c650f6cdededbb9b9f7c27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abacb259344c650f6cdededbb9b9f7c27">&#9670;&nbsp;</a></span>getTransport()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a>* PxPvd::getTransport </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>returns the PVD data transport returns NULL if no transport is present. </p>

</div>
</div>
<a id="af6ab8818ce89858b70e6e7a868cbcf6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6ab8818ce89858b70e6e7a868cbcf6f">&#9670;&nbsp;</a></span>isConnected()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxPvd::isConnected </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>useCachedStatus</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Return if connection to PVD is created. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">useCachedStatus</td><td>1&gt; When useCachedStaus is false, <a class="el" href="classPxPvd.html#af6ab8818ce89858b70e6e7a868cbcf6f">isConnected()</a> checks the lowlevel network status. This can be slow because it needs to lock the lowlevel network stream. If <a class="el" href="classPxPvd.html#af6ab8818ce89858b70e6e7a868cbcf6f">isConnected()</a> is called frequently, the expense of locking can be significant. 2&gt; When useCachedStatus is true, <a class="el" href="classPxPvd.html#af6ab8818ce89858b70e6e7a868cbcf6f">isConnected()</a> checks the highlevel cached status with atomic access. It is faster than locking, but the status may be different from the lowlevel network with latency of up to one frame. The reason for this is that the cached status is changed inside socket listener, which is not called immediately when the lowlevel connection status changes. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a43e5b5e2d72edb4a322caf6cfb55dd58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43e5b5e2d72edb4a322caf6cfb55dd58">&#9670;&nbsp;</a></span>release()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvd::release </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Releases the pvd instance. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxPvd_8h_source.html">PxPvd.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxPvd.html">PxPvd</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
